﻿CITADEL DESK — QUICK START

1. Extract the entire ZIP into a writable folder, such as Documents.
2. Open CitadelDesk.exe. First use starts with a blank workspace.
3. Choose Open and select your own supported build file.

CONNECT YOUR HYTALE TEXTURES

Citadel Desk usually finds a standard Hytale installation automatically.
Each person needs their own installed game. Game assets are not included
with this download.

To check or change the connection:

1. In Citadel Desk, choose Project > Connect Hytale textures.
2. If it says Connected, you are ready.
3. Otherwise, click Choose Assets.zip.
4. Browse to your Hytale installation, then open:
   install > release > package > game > latest
5. Select Assets.zip. Do not unzip it.

The usual file location is:
%APPDATA%\Hytale\install\release\package\game\latest\Assets.zip

You can paste %APPDATA%\Hytale into File Explorer's address bar and press
Enter to find the usual Hytale folder. The app also has an Open Hytale
folder button. If you installed the game somewhere else, browse there.

Select the base game's Assets.zip, not a mod-only texture pack. Citadel
Desk reads the file without changing it and remembers your selection.
If a game update moves the file, connect it again through the same menu.

CHOOSING REPLACEMENTS

Select a material, then click Hytale block. The most relevant replacement
is first, followed by related objects and materials. Click a thumbnail
to compare it, then Use this block to save your choice. Search and the
shape filter narrow the list.

For example, campfires use Small Campfire; unlit campfires use Dead Embers.
Unrecognized objects request review instead of becoming unrelated blocks
based only on color. Saved manual choices are preserved; Restore automatic
match applies the current suggestion if you want to replace an old choice.

Minecraft textures for the ORIGINAL preview are separate and optional.
Use Minecraft textures in the picker to select a local Minecraft JAR or
resource-pack ZIP. Without one, the original preview is labeled shape-only.

PROGRESS AND BUG REPORTS

Keep the data folder beside the app when updating; it contains your progress.
For issues, choose Project > Report a bug and send the saved report ZIP to
the person who shared the app. They can open it using Review bug report.
Reports are not sent automatically.

See README.md for the full controls and limitations.

BUILD TOOLS

Advanced > All build tools in the top bar contains:
  Build: connected selection, repeated patterns, bulk completion,
                 a placement checklist, and hiding completed 2D blocks.
  Navigate: named markers, saved viewpoints, material location cycling,
            a 3D minimap, and X/Y/Z cutaways.
  Materials: reusable presets, material theme previews, match feedback.
  History: undo, redo, saved progress copies, and automatic/manual backups.
Portable .citadel projects are in Project.

Ctrl+Z / Ctrl+Y undo and redo saved changes during the current session.
The block picker also offers Preview in build before applying a replacement.
Read README.md for usage, search limits, and recovery instructions.


MORE FILE FORMATS

Java: .schem, .schematic, .litematic, .nbt, .bp and world .zip
Bedrock: .mcstructure and .mcworld
Hytale: .prefab.json and .hytale.world.zip

Keep CitadelImport.exe beside CitadelDesk.exe. Nothing else needs installing.
World files ask you to choose a world, dimension and an area by coordinates.
Enter the first and last blocks, inclusive. Start small for faster importing.
Imported builds, progress and notes stay in the data folder. Keep it when updating.
Read the supported versions and limitations in README.md.

NEW LAYOUT

Menus at the top, quick tool icons on the left, layer controls on the right,
materials along the bottom. Right-click a material for its options.
View contains the grid, previous-layer overlay, check-off and measure controls.
Light-emitting sources suggest compatible Hytale lights or request review.


NEW IN 1.3.0

The side controls float over the canvas with transparency. Hover over a
menu option or tool for about a second to read its explanation. Advanced > All build tools
uses four category tabs with matching buttons.

Both 2D and 3D remember where you were when you switch away. Returning to
2D restores the layer, zoom, pan and rotation. Returning to 3D restores
the camera and viewing mode. Fit changes only the view you are using.

Materials in the top bar has a visible search. The replacement image picker has
name/ID search, a clear button and Ctrl+F. Type multiple words in any
order; the most likely compatible matches stay first.


NEW IN 1.4.0

Use the top bar for Open, Project, View, Materials, Sections, Advanced and Help.
The left Tools icon expands a row of quick tools and changes to an X to close.

The Menu, Layers and Materials tabs hide or reopen their panels with a slide.
F8 hides all panels or restores your previous arrangement. Your panel choices
are saved when you close the app.

Measure and Connected switches are beside Entire build in the bottom bar.
Measure: click two grid cells, including empty spaces, to count the span.
Connected: hover on a block to outline and count its touching group on this
layer. It counts same-source-type blocks; diagonal contact does not connect.

Right-click a material and choose Mark collected to complete its required
collected amount. Placed-block checkmarks are tracked separately.

Stair arrows point toward the smaller step. N is normal; U is upside down.
Help opens a short guide you can leave open while learning the controls.
